<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class FB</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class FB</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
		<p class="notes">
			Located in <a class="field" href="_FirePHPCore---fb.php.html">/FirePHPCore/fb.php</a> (line <span class="field">68</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#dump" title="details" class="method-name">dump</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$Key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$Variable</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#error" title="details" class="method-name">error</a>
											(<span class="var-type">mixes</span>&nbsp;<span class="var-name">$Object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">boolean</span>
										<a href="#getEnabled" title="details" class="method-name">getEnabled</a>
										()
									</div>
																<div class="method-definition">
					static 						<span class="method-result">array</span>
										<a href="#getOptions" title="details" class="method-name">getOptions</a>
										()
									</div>
																<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#group" title="details" class="method-name">group</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$Name</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$Options</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#groupEnd" title="details" class="method-name">groupEnd</a>
										()
									</div>
																<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#info" title="details" class="method-name">info</a>
											(<span class="var-type">mixes</span>&nbsp;<span class="var-name">$Object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#log" title="details" class="method-name">log</a>
											(<span class="var-type">mixes</span>&nbsp;<span class="var-name">$Object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#send" title="details" class="method-name">send</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$Object</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#setEnabled" title="details" class="method-name">setEnabled</a>
											(<span class="var-type">boolean</span>&nbsp;<span class="var-name">$Enabled</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#setObjectFilter" title="details" class="method-name">setObjectFilter</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$Class</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$Filter</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#setOptions" title="details" class="method-name">setOptions</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$Options</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#table" title="details" class="method-name">table</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$Table</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#trace" title="details" class="method-name">trace</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">true</span>
										<a href="#warn" title="details" class="method-name">warn</a>
											(<span class="var-type">mixes</span>&nbsp;<span class="var-name">$Object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span> = <span class="var-default">null</span>])
									</div>
								
																																																																																																																												</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methoddump" id="dump"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method dump</span> (line <span class="line-number">244</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Dumps key and variable to firebug server panel</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../FirePHPCore/FirePHP.html#constDUMP">FirePHP::DUMP</a></li>
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			dump
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$Key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$Variable</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Key</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$Variable</span>			</li>
				</ul>
		
			
	</div>
<a name="methoderror" id="error"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method error</span> (line <span class="line-number">230</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log object with label to firebug console</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../FirePHPCore/FirePHP.html#constERROR">FirePHP::ERROR</a></li>
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			error
		</span>
					(<span class="var-type">mixes</span>&nbsp;<span class="var-name">$Object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixes</span>
				<span class="var-name">$Object</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Label</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetEnabled" id="getEnabled"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method getEnabled</span> (line <span class="line-number">89</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check if logging is enabled</p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE if enabled</li>
				<li><span class="field">see:</span> FirePHP-&gt;getEnabled()</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">boolean</span>
		<span class="method-name">
			getEnabled
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetOptions" id="getOptions"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method getOptions</span> (line <span class="line-number">130</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get options for the library</p>
	<ul class="tags">
				<li><span class="field">return:</span> The options</li>
				<li><span class="field">see:</span> FirePHP-&gt;getOptions()</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">array</span>
		<span class="method-name">
			getOptions
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgroup" id="group"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method group</span> (line <span class="line-number">162</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Start a group for following messages</p>
<p class="description"><p>Options:    Collapsed: [true|false]    Color:     [#RRGGBB|ColorName]</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			group
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$Name</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$Options</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Name</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$Options</span><span class="var-description">: OPTIONAL Instructions on how to log the group</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgroupEnd" id="groupEnd"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method groupEnd</span> (line <span class="line-number">174</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Ends a group you have started before</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			groupEnd
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodinfo" id="info"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method info</span> (line <span class="line-number">202</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log object with label to firebug console</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../FirePHPCore/FirePHP.html#constINFO">FirePHP::INFO</a></li>
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			info
		</span>
					(<span class="var-type">mixes</span>&nbsp;<span class="var-name">$Object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixes</span>
				<span class="var-name">$Object</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Label</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlog" id="log"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method log</span> (line <span class="line-number">188</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log object with label to firebug console</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../FirePHPCore/FirePHP.html#constLOG">FirePHP::LOG</a></li>
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			log
		</span>
					(<span class="var-type">mixes</span>&nbsp;<span class="var-name">$Object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixes</span>
				<span class="var-name">$Object</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Label</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsend" id="send"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method send</span> (line <span class="line-number">144</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log object to firebug</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="http://www.firephp.org/Wiki/Reference/Fb">http://www.firephp.org/Wiki/Reference/Fb</a></li>
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			send
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$Object</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$Object</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetEnabled" id="setEnabled"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method setEnabled</span> (line <span class="line-number">77</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enable and disable logging to Firebug</p>
	<ul class="tags">
				<li><span class="field">see:</span> FirePHP-&gt;setEnabled()</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			setEnabled
		</span>
					(<span class="var-type">boolean</span>&nbsp;<span class="var-name">$Enabled</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$Enabled</span><span class="var-description">: TRUE to enable, FALSE to disable</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetObjectFilter" id="setObjectFilter"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method setObjectFilter</span> (line <span class="line-number">105</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Specify a filter to be used when encoding an object</p>
<p class="description"><p>Filters are used to exclude object members.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> FirePHP-&gt;setObjectFilter()</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			setObjectFilter
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$Class</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$Filter</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Class</span><span class="var-description">: The class name of the object</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$Filter</span><span class="var-description">: An array or members to exclude</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetOptions" id="setOptions"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method setOptions</span> (line <span class="line-number">118</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set some options for the library</p>
	<ul class="tags">
				<li><span class="field">see:</span> FirePHP-&gt;setOptions()</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			setOptions
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$Options</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$Options</span><span class="var-description">: The options to be set</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtable" id="table"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method table</span> (line <span class="line-number">271</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a table in the firebug console</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../FirePHPCore/FirePHP.html#constTABLE">FirePHP::TABLE</a></li>
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			table
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$Table</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Label</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Table</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtrace" id="trace"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method trace</span> (line <span class="line-number">257</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a trace in the firebug console</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../FirePHPCore/FirePHP.html#constTRACE">FirePHP::TRACE</a></li>
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			trace
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Label</span>			</li>
				</ul>
		
			
	</div>
<a name="methodwarn" id="warn"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method warn</span> (line <span class="line-number">216</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log object with label to firebug console</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../FirePHPCore/FirePHP.html#constWARN">FirePHP::WARN</a></li>
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">true</span>
		<span class="method-name">
			warn
		</span>
					(<span class="var-type">mixes</span>&nbsp;<span class="var-name">$Object</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$Label</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixes</span>
				<span class="var-name">$Object</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Label</span>			</li>
				</ul>
		
			
	</div>

						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sat, 21 Jun 2014 20:39:59 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>